<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html><head><title>QHelpSearchQuery Class Reference</title><style>h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
td.postheader { font-family: sans-serif }
tr.address { font-family: sans-serif }
body { background: #ffffff; color: black; }
</style></head><body><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr /><td align="left" valign="top" width="32"><img align="left" border="0" height="32" src="images/rb-logo.png" width="32" /></td><td width="1">&#160;&#160;</td><td class="postheader" valign="center"><a href="../pyqt4ref.html"><font color="#004faf">Home</font></a>&#160;&#183; <a href="classes.html"><font color="#004faf">All Classes</font></a>&#160;&#183; <a href="modules.html"><font color="#004faf">Modules</font></a></td></table><h1 align="center">QHelpSearchQuery Class Reference<br /><sup><sup>[<a href="qthelp.html">QtHelp</a> module]</sup></sup></h1><p>The QHelpSearchQuery class contains the field name and the associated search term <a href="#details">More...</a></p>
<h3>Types</h3><ul><li><div class="fn" />enum <b><a href="qhelpsearchquery.html#FieldName-enum">FieldName</a></b> { DEFAULT, FUZZY, WITHOUT, PHRASE, ALL, ATLEAST }</li></ul><h3>Methods</h3><ul><li><div class="fn" /><b><a href="qhelpsearchquery.html#QHelpSearchQuery">__init__</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qhelpsearchquery.html#QHelpSearchQuery-2">__init__</a></b> (<i>self</i>, FieldName, QStringList)</li><li><div class="fn" /><b><a href="qhelpsearchquery.html#QHelpSearchQuery-3">__init__</a></b> (<i>self</i>, QHelpSearchQuery)</li></ul><a name="details" /><hr /><h2>Detailed Description</h2><p>The QHelpSearchQuery class contains the field name and the associated search term</p>
<p>The QHelpSearchQuery class contains the field name and the associated search term. Depending on the field the search term might get split up into seperate terms to be parsed differently by the search engine.</p>
<p>See also <a href="qhelpsearchquerywidget.html">QHelpSearchQueryWidget</a>.</p>
<hr /><h2>Type Documentation</h2><h3 class="fn"><a name="FieldName-enum" />QHelpSearchQuery.FieldName</h3><p>This enum type specifies the field names that are handled by the search engine.</p>
<p><table border="1" cellpadding="2" cellspacing="1" class="valuelist" width="100%">
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
<tr><td valign="top"><tt>QHelpSearchQuery.DEFAULT</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">the default field provided by the search widget, several terms should be split and stored in the word list except search terms enclosed in quotes.</td></tr>
<tr><td valign="top"><tt>QHelpSearchQuery.FUZZY</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">a field only provided in use with clucene. Terms should be split in seperate words and passed to the search engine.</td></tr>
<tr><td valign="top"><tt>QHelpSearchQuery.WITHOUT</tt></td><td align="center" valign="top"><tt>2</tt></td><td valign="top">a field only provided in use with clucene. Terms should be split in seperate words and passed to the search engine.</td></tr>
<tr><td valign="top"><tt>QHelpSearchQuery.PHRASE</tt></td><td align="center" valign="top"><tt>3</tt></td><td valign="top">a field only provided in use with clucene. Terms should not be split in seperate words.</td></tr>
<tr><td valign="top"><tt>QHelpSearchQuery.ALL</tt></td><td align="center" valign="top"><tt>4</tt></td><td valign="top">a field only provided in use with clucene. Terms should be split in seperate words and passed to the search engine</td></tr>
<tr><td valign="top"><tt>QHelpSearchQuery.ATLEAST</tt></td><td align="center" valign="top"><tt>5</tt></td><td valign="top">a field only provided in use with clucene. Terms should be split in seperate words and passed to the search engine</td></tr>
</table></p>
<hr /><h2>Method Documentation</h2><h3 class="fn"><a name="QHelpSearchQuery" />QHelpSearchQuery.__init__ (<i>self</i>)</h3><p>Constructs a new empty <a href="qhelpsearchquery.html">QHelpSearchQuery</a>.</p>
<h3 class="fn"><a name="QHelpSearchQuery-2" />QHelpSearchQuery.__init__ (<i>self</i>, <a href="qhelpsearchquery.html#FieldName-enum">FieldName</a>, QStringList)</h3><p>Constructs a new <a href="qhelpsearchquery.html">QHelpSearchQuery</a> and initializes it with the given <i>field</i> and <i>wordList</i>.</p>
<p /><h3 class="fn"><a name="QHelpSearchQuery-3" />QHelpSearchQuery.__init__ (<i>self</i>, <a href="qhelpsearchquery.html">QHelpSearchQuery</a>)</h3><address><hr /><div align="center"><table border="0" cellspacing="0" width="100%"><tr class="address"><td align="left" width="25%">PyQt&#160;snapshot-4.7.1-5014f7c72a58 for X11</td><td align="center" width="50%">Copyright &#169; <a href="http://www.riverbankcomputing.com">Riverbank&#160;Computing&#160;Ltd</a> and <a href="http://www.qtsoftware.com">Nokia</a> 2010</td><td align="right" width="25%">Qt&#160;4.6.1</td></tr></table></div></address></body></html>